home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / PROGTOOL / DOCZ16.ZIP;1 / DOCZ.LIF / DOCHELP.TXT < prev    next >
Encoding:
Text File  |  1994-04-24  |  6.5 KB  |  316 lines
  1. DOC
  2.  
  3. DOCZ
  4.  
  5. DOCUMENTATION
  6. PROJECT
  7.  
  8. Module documentation
  9.  
  10. EXITBAD     if DOC cannot run
  11. EXITWARN    if no modules match the user specified criteria
  12. EXITNORMAL  if one or more modules match the user specified criteria
  13.  
  14. DOC <library name> [/l=n1,n2,n3...] [z_opt]
  15.    -> entire library
  16. DOC <library name> <module> [module]...[module] [/l=n1,n2,n3...] [z_opt]
  17.    -> module(s) docs
  18. DOC <library name> </m[=date]> [/s] [/l=n1,n2,n3...] [z_opt]
  19.    -> modified since
  20. DOC <library name> </r[=date]> [/s] [/l=n1,n2,n3...] [z_opt]
  21.    -> revised since
  22. DOC <library name> </i[=date]> [/s] [/l=n1,n2,n3...] [z_opt]
  23.    -> introduced since
  24. DOC <library name> </f[=date]> [/s] [/l=n1,n2,n3...] [z_opt]
  25.    -> fixed since
  26. DOC <library name> </s> [z_opt]
  27.    -> library summary
  28. Option [z_opt] is:
  29.    /z=docref=<alternate DOCREF directory>
  30. and/or
  31.    /z=docsrc=<alternate DOCSRC directory>
  32.  
  33. DOCXL
  34.  
  35. DOCZ
  36.  
  37. DOCUMENTATION
  38.  
  39. Library/module reference indexing program
  40.  
  41. EXITNORMAL unless the index cannot be opened:  EXITBAD.
  42.  
  43. DOCXL <library> <module> <source> [z_opt]
  44.    module add/update
  45. DOCXL [library] /d [z_opt]
  46.    display index
  47. DOCXL [library] /dm[=MM/DD/YY] [z_opt]
  48.    display modified since
  49. DOCXL [library] /di[=MM/DD/YY] [z_opt]
  50.    display introduced since
  51. DOCXL [library] /p [z_opt]
  52.    print index
  53. DOCXL [library] /pm[=MM/DD/YY] [z_opt]
  54.    print modified since
  55. DOCXL [library] /pi[=MM/DD/YY] [z_opt]
  56.    print introduced since
  57. DOCXL <library> <module> /x[x] [z_opt]
  58.    delete
  59. DOCXL <module> /s[=<output file>] [z_opt]
  60.    search
  61. DOCXL [library] /o[=L[M[F[D[T[I]]]]]] [z_opt]
  62.    output fields
  63. Option [z_opt] is:
  64.    /z=docref=<alternate DOCREF directory>
  65. and/or
  66.    /z=docsrc=<alternate DOCSRC directory>
  67.  
  68. DOCXLED
  69.  
  70. DOCZ
  71.  
  72. DOCUMENTATION
  73.  
  74. Examine/search/modify the Documentation Index File
  75.  
  76. Nothing
  77.  
  78. DOCXLED [z_opt]
  79.    Option [z_opt] is:
  80.       /z=docref=<alternate DOCREF directory>
  81.    and/or
  82.       /z=docsrc=<alternate DOCSRC directory>
  83.  
  84. DOCHBLD
  85.  
  86. DOCZ
  87.  
  88. DOCUMENTATION
  89.  
  90. Generate a library documentation help file
  91.  
  92. EXITWARN if no modules are found.  EXITBAD if the DOCZ environment
  93. is not correct.  EXITNORMAL normally.
  94.  
  95. DOCHBLD [library] [library] ... [/opt]
  96.    options:
  97.       /h                               update the on-line help library
  98.       /v                               VMS help library format
  99.       /ao=<filename>                   ASCII transport output
  100.       /ai=<filenmae>[,filename,...]    ASCII transport input
  101.       /z=docref=<alternate DOCREF directory>
  102.       /z=docsrc=<alternate DOCSRC directory>
  103.  
  104. DOCHELP
  105.  
  106. DOCZ
  107.  
  108. DOCUMENTATION
  109.  
  110. Produce on-line help documentation
  111.  
  112. Nothing
  113.  
  114. DOCHELP interactive mode --
  115.   DOCHELP> <module name>
  116.     display abbreviated module documentation
  117.   DOCHELP> <ambiguous module name(s)>
  118.     display wildcard matches to module names
  119.   DOCHELP> /<pattern>
  120.     search for pattern in all module DESCRIPTIONS
  121.   DOCHELP> ?
  122.     display DOCHELP program options
  123. DOCHELP command line mode --
  124.   DOCHELP <module name> [/arg]
  125.     ambiguous or unambiguous module name matching
  126.      /arg   display only documentation ARGUMENTS
  127.  
  128. DOCGET
  129.  
  130. DOCZ
  131.  
  132. DOCUMENTATION
  133.  
  134. Extract a field from a documentation header
  135.  
  136. nothing
  137.  
  138. docget <module> <source file> <parameter> [/o=<output file>]
  139.  
  140. DOCXLU
  141.  
  142. DOCZ
  143.  
  144. DOCUMENTATION
  145.  
  146. Documentation Index File utility
  147.  
  148. EXITNORMAL unless the index cannot be opened:  EXITBAD.
  149.  
  150. DOCXLU /r [z_opt]
  151.    repair/rebuild index
  152. DOCXLU /e <other index directory> <library>...[library] [z_opt]
  153.    extract library for another Documentation Index File
  154. DOCXLU /ao=<output file> [library] ... [library] [z_opt]
  155.    produce ASCII transport file
  156. DOCXLU /ai=<input file> [z_opt]
  157.    read ASCII transport file
  158. DOCXLU /s[=<output file>] [z_opt]
  159.    display DOCZ System statistics
  160. DOCXLU /v[=<output file>] [z_opt]
  161.    verify source for each module
  162. DOCXLU <library> /c[=<output file>] [z_opt]
  163.    check for rogue files
  164.  
  165. DOCLOG
  166.  
  167. DOCZ
  168.  
  169. ERROR
  170.  
  171. Examine/search the log file
  172.  
  173. Nothing
  174.  
  175. DOCLOG [z_opt]
  176.  
  177. DOCLIS
  178.  
  179. DOCZ
  180.  
  181. DOCUMENTATION
  182.  
  183. Find all DOCZ modules in a source file
  184.  
  185. nothing
  186.  
  187. DOCLIS <a.f.n.> [/o=<output file>]
  188. DOCLIS <a.f.n.> [z_opt] /c[=<command> [command arg] ... [command arg]]
  189. DOCLIS <a.f.n.> [z_opt] /e=<command> [command arg] ... [command arg]
  190.  
  191. DOCMAN
  192.  
  193. DOCZ
  194.  
  195. DOCUMENTATION
  196.  
  197. Review DOCZ on-line User Manual
  198.  
  199. Nothing
  200.  
  201. docman [/m] [z_opt]
  202.  
  203. DOCLEARN
  204.  
  205. DOCZ
  206.  
  207. DOCUMENTATION
  208.  
  209. Run the on-line DOCZ tutorial
  210.  
  211. Nothing
  212.  
  213. doclearn [/m] [z_opt]
  214.  
  215. PSET
  216.  
  217. TOOLZ
  218.  
  219. PRINTER
  220.  
  221. Printer configuration
  222.  
  223. EXITNORMAL upon successful completion, EXITWARN on bad options.
  224.  
  225. PSET <token> [token] [token]      Send output to default printer/queue
  226. PSET <token> [token] [/D=nnnnn]   Send output to printer/queue 'nnnnn'
  227. PSET <token> [token] [/Q=nnnnn]   Send output to printer/queue 'nnnnn'
  228. PSET ?                            Display all tokens
  229. PSET /E                           Edit the printer sequences
  230. PSET /U=nnnnn                     Send dump of all sequences to file 'nnnnn'
  231. PSET [token] [/T=ww/hh]           Print test pattern, 'ww' width/'hh' height
  232. PSET [token] [/O]                 Send output to standard output
  233. PSET [token] [/O=nnnnn]           Append output to file 'nnnnn'
  234. PSET                              Display command line options
  235. PSET /AI=[input transport file]   Read a transport file
  236. PSET /AO=[output transport file]  Output a transport file
  237.  
  238. PCODE
  239.  
  240. TOOLZ
  241.  
  242. PRINTER
  243.  
  244. Install the PSET database for a particular printer
  245.  
  246. Nothing
  247.  
  248. PCODE [directory for PCODE.DAT]
  249.  
  250. CALCDATE
  251.  
  252. TOOLZ
  253.  
  254. DATE/TIME
  255.  
  256. Display current date in local date format
  257.  
  258. nothing
  259.  
  260. calcdate [date] [/o=output file] [+/- days] [/v] [/f=<date format>]
  261.  
  262. REFORMAT
  263.  
  264. TOOLZ
  265.  
  266. FILE
  267.  
  268. Reformat a text data file into print image
  269.  
  270. EXITNORMAL on success, EXITBAD if options are not properly specified
  271. or files cannot be opened.
  272.  
  273. reformat <input file> <output file> [opt]
  274.    Options:
  275.       /s=<width>     Column width separator size
  276.       /jr            Justify right
  277.       /jc            Justify center
  278.       /t[=n]         Use TABs to align
  279.  
  280. FILLS
  281.  
  282. TOOLZ
  283.  
  284. FILE
  285.  
  286. See if a file is space-filled or tab-filled
  287.  
  288. nothing
  289.  
  290. fills <a.f.n.> [a.f.n.] ... [a.f.n.]
  291.  
  292. RETAB
  293.  
  294. TOOLZ
  295.  
  296. FILE
  297.  
  298. Convert spaces to TAB characters
  299.  
  300. nothing
  301.  
  302. retab <a.f.n.> [a.f.n.] ... [a.f.n.] [/tab_stop]
  303.  
  304. DETAB
  305.  
  306. TOOLZ
  307.  
  308. CONVERSION
  309.  
  310. Expands all TAB characters to spaces
  311.  
  312. Nothing
  313.  
  314. DETAB <a.f.n.> [a.f.n.] [a.f.n.] ... [/tab stop]
  315.  
  316.